GermanWikipedia - /page/entry.mu

Micron Document

<!DOCTYPE html>

<title>Doxygen</title>

</head>

<h1 id="firstHeading" class="firstHeading mw-first-heading"><span class="mw-page-title-main">Doxygen</span></h1>

</header>

</div>

<th colspan="2" class="hintergrundfarbe6" style="font-size:105%; text-align:center;">Doxygen

</p>

</th></tr>

<tr>

</td></tr>

<tr>

<td colspan="2" style="text-align:center;"><span typeof="mw:File"></span><br> Eine mit Doxygen erzeugte Dokumentation einer C++-Klasse

</td></tr>

<tr>

<th colspan="2" class="hintergrundfarbe5" style="font-size:105%; text-align:center;">Basisdaten

</p>

</th></tr>

<tr>

<td><b><a href="Softwareentwickler" title="Softwareentwickler">Entwickler</a></b>

</td>

<td>Dimitri van Heesch

</td></tr>

<tr>

<td><b>Erscheinungsjahr</b>

</td>

<td><span class="wikidata-content">26. Oktober 1997<sup id="cite_ref-_d087fe8a254d28e6_1-0" class="reference"><a href="#cite_note-_d087fe8a254d28e6-1"><span class="cite-bracket">[</span>1<span class="cite-bracket">]</span></a></sup></span>

</td></tr>

<tr>

<td><b>Aktuelle <a href="Version_(Software)" title="Version (Software)">Version</a></b>

</td>

<td><span class="wikidata-content">1.16.1<sup id="cite_ref-_332f804fc8684018_2-0" class="reference"><a href="#cite_note-_332f804fc8684018-2"><span class="cite-bracket">[</span>2<span class="cite-bracket">]</span></a></sup></span> <br> (<span class="wikidata-content">11. Januar 2026</span>)

</td></tr>

<tr>

<td><b><a href="Betriebssystem" title="Betriebssystem">Betriebssystem</a></b>

</td>

<td><a href="Linux" title="Linux">Linux</a>, <a href="MacOS" title="MacOS">macOS</a>, <a href="Solaris_(Betriebssystem)" title="Solaris (Betriebssystem)">Solaris</a>, <a href="Unix" title="Unix">Unix</a>, <a href="Microsoft_Windows_NT" title="Microsoft Windows NT">Windows</a>

</td></tr>

<tr>

<td><b><a href="Programmiersprache" title="Programmiersprache">Programmiersprache</a></b>

</td>

</td></tr>

<tr>

<td><b>Kategorie</b>

</td>

<td><a href="Software-Dokumentationswerkzeug" title="Software-Dokumentationswerkzeug">Software-Dokumentationswerkzeug</a>

</td></tr>

<tr>

<td><b>Lizenz</b>

</td>

<td><span class="wikidata-content"><a href="GPLv2" class="mw-redirect" title="GPLv2">GNU General Public License, Version 2</a><sup id="cite_ref-_6c34e8a5d5e5402c_3-0" class="reference"><a href="#cite_note-_6c34e8a5d5e5402c-3"><span class="cite-bracket">[</span>3<span class="cite-bracket">]</span></a></sup></span>

</td></tr>

<tr>

<td><b><a href="Lokalisierung_(Softwareentwicklung)" title="Lokalisierung (Softwareentwicklung)">deutschsprachig</a></b>

</td>

<td>ja

</td></tr>

<tr>

<td class="hintergrundfarbe5" colspan="2" style="text-align:center;"><a rel="nofollow" class="external text" href="https://www.doxygen.org/">www.doxygen.org</a>

</td></tr></tbody></table>

<p><b>Doxygen</b> ist ein <a href="Freie_Software" title="Freie Software">freies</a> <a href="Software-Dokumentationswerkzeug" title="Software-Dokumentationswerkzeug">Software-Dokumentationswerkzeug</a> unter der <a href="GNU_General_Public_License" title="GNU General Public License">GNU General Public License</a>.

</p>

<div class="mw-heading mw-heading2"><h2 id="Hintergrund_und_Motivation">Hintergrund und Motivation</h2></div>

<p>Durch spezielle Kommentare im <a href="Quelltext" title="Quelltext">Quelltext</a> können <a href="Softwareentwickler" title="Softwareentwickler">Softwareentwickler</a> Erläuterungen zu Programmelementen definieren, aus denen Doxygen eine übersichtliche <a href="Softwaredokumentation#Programmiererdokumentation" title="Softwaredokumentation">Dokumentation</a> erstellt. Außerdem ist es möglich, einen zusammenfassenden Überblick über den Aufbau und die Elemente eines bereits existierenden <a href="Computerprogramm" title="Computerprogramm">Programms</a> (verwendete <a href="Datei" title="Datei">Dateien</a>, <a href="Funktion_(Programmierung)" title="Funktion (Programmierung)">Funktionen</a>, <a href="Variable_(Programmierung)" title="Variable (Programmierung)">Variablen</a> sowie deren jeweilige Rolle im Programmablauf) zu erzeugen.

</p><p>Das Ziel einer solchen Dokumentationsmethode ist die Vermeidung von Redundanz und die Steigerung der Übersichtlichkeit des Codes. Die Dokumentation im Quelltext selbst kann dabei helfen, das Auseinanderdriften zwischen den Programmstrukturen (Funktionen, Klassen, Methoden usw.) und der Dokumentation zu verringern.

</p><p>Als <a href="Grafische_Benutzeroberfl%C3%A4che" title="Grafische Benutzeroberfläche">grafische Benutzeroberfläche</a> dient der sogenannte <b>Doxywizard</b>, mit dem die <a href="Konfiguration_(Computer)" title="Konfiguration (Computer)">Einstellungen</a>, welche Art und Form der Dokumentationserzeugung steuern, einfach vorgenommen werden können.

</p><p>Die meisten gängigen Entwicklungsumgebungen (<a href="Integrierte_Entwicklungsumgebung" title="Integrierte Entwicklungsumgebung">IDE</a>) unterstützen Doxygen durch <a href="Syntaxhervorhebung" title="Syntaxhervorhebung">Syntaxhervorhebung</a>.

</p><p>Die erste Doxygen-Version verwendete Quelltext von DOC++, das am <a href="Konrad-Zuse-Zentrum_f%C3%BCr_Informationstechnik_Berlin" class="mw-redirect" title="Konrad-Zuse-Zentrum für Informationstechnik Berlin">Zuse-Institut Berlin</a> von Roland Wunderling und Malte Zöckler entwickelt wurde.

</p><p>Doxygen ist kompatibel zur <a href="Versionierung" class="mw-redirect" title="Versionierung">Code-Versionierung</a> mit <a href="Subversion_(Software)" class="mw-redirect" title="Subversion (Software)">Subversion</a>, womit automatisch erzeugte Codes für Autoren, Bearbeiter, Datum und Zeitpunkt des Eincheckens in die Doxygen-Dokumentation übernommen werden können.

</p>

<div class="mw-heading mw-heading2"><h2 id="Unterstützte_Programmiersprachen"><span id="Unterst.C3.BCtzte_Programmiersprachen"></span>Unterstützte Programmiersprachen</h2></div>

<p>Unterstützte Programmiersprachen sind <a href="C%2B%2B" title="C++">C++</a>, <a href="C_(Programmiersprache)" title="C (Programmiersprache)">C</a>, <a href="Objective-C" title="Objective-C">Objective-C</a>, <a href="Java_(Programmiersprache)" title="Java (Programmiersprache)">Java</a>, <a href="Python_(Programmiersprache)" title="Python (Programmiersprache)">Python</a>, <a href="Fortran" title="Fortran">Fortran</a> und <a href="Interface_Description_Language" class="mw-redirect" title="Interface Description Language">IDL</a>. Sie werden in ihrem vollen Sprachumfang unterstützt. Mit Einschränkungen ist auch die Kommentierung von <a href="PHP" title="PHP">PHP</a>, <a href="C-Sharp" title="C-Sharp">C#</a>, <a href="D_(Programmiersprache)" title="D (Programmiersprache)">D</a> und <a href="Very_High_Speed_Integrated_Circuit_Hardware_Description_Language" title="Very High Speed Integrated Circuit Hardware Description Language">VHDL</a> möglich. Ab Version 1.7.5 wird <a href="Tcl" title="Tcl">Tcl</a> unterstützt. Durch zusätzliche Filter kann auch Quellcode in <a href="Perl_(Programmiersprache)" title="Perl (Programmiersprache)">Perl</a> oder <a href="Object_Pascal" title="Object Pascal">Object Pascal</a> bearbeitet werden.

</p>

<div class="mw-heading mw-heading2"><h2 id="Unterstützte_Ausgabeformate"><span id="Unterst.C3.BCtzte_Ausgabeformate"></span>Unterstützte Ausgabeformate</h2></div>

<p>Als Ausgabeformat unterstützt Doxygen <a href="Hypertext_Markup_Language" title="Hypertext Markup Language">HTML</a>, <a href="CHM_(Dateiformat)" title="CHM (Dateiformat)">CHM</a>, <a href="LaTeX" title="LaTeX">LaTeX</a>, <a href="Extensible_Markup_Language" title="Extensible Markup Language">XML</a>, <a href="Rich_Text_Format" title="Rich Text Format">RTF</a>, <a href="PostScript" title="PostScript">PostScript</a>, <a href="PDF" class="mw-redirect" title="PDF">PDF</a>, <a href="Manpage" title="Manpage">Manpages</a> und <a href="Markdown" title="Markdown">Markdown</a>.<sup id="cite_ref-4" class="reference"><a href="#cite_note-4"><span class="cite-bracket">[</span>4<span class="cite-bracket">]</span></a></sup> Auch lassen sich entsprechende Steuerdaten für die Erstellung von Hilfedateien für das Hilfesystem von <a href="Qt_(Bibliothek)" title="Qt (Bibliothek)">Qt</a> erstellen. Ab Version 1.8.8 wird auch <a href="PlantUML" title="PlantUML">PlantUML</a> unterstützt, um <a href="Unified_Modeling_Language#Diagramme" title="Unified Modeling Language">UML-Diagramme</a> zu erstellen.<sup id="cite_ref-5" class="reference"><a href="#cite_note-5"><span class="cite-bracket">[</span>5<span class="cite-bracket">]</span></a></sup>

</p>

<div class="mw-heading mw-heading2"><h2 id="Beispiel">Beispiel</h2></div>

<p>Die Dokumentierung einer Funktion kann wie folgt in den Quelltext eingebettet werden (hier in der Programmiersprache C):

</p>

<span class="cm"> * \brief Exemplarische Funktion</span>

<span class="cm"> * Diese Funktion gibt den übergebenen Parameter</span>

<span class="cm"> * auf der Konsole aus.</span>

<span class="cm"> * \param parameter Auszugebender Parameter</span>

<span class="cm"> * \return Status-Code</span>

<span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="nf">funktion</span><span class="p">(</span><span class="kt">int</span><span class="w"> </span><span class="n">parameter</span><span class="p">)</span>

<span class="w"> </span><span class="n">printf</span><span class="p">(</span><span class="s">"Parameter: %d"</span><span class="p">,</span><span class="w"> </span><span class="n">parameter</span><span class="p">);</span>

<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>

</pre></div>

<div class="mw-heading mw-heading2"><h2 id="Ähnliche_Werkzeuge"><span id=".C3.84hnliche_Werkzeuge"></span>Ähnliche Werkzeuge</h2></div>

<ul><li><a href="Javadoc" title="Javadoc">Javadoc</a>, <a href="Natural_Docs" title="Natural Docs">Natural Docs</a>, <a href="PhpDocumentor" title="PhpDocumentor">phpDocumentor</a>, ASDoc, ROBODoc, Sandcastle, AutoDuck, pydoc, HeaderDoc, <a href="Plain_Old_Documentation" title="Plain Old Documentation">Plain Old Documentation</a>, <a href="Sphinx_(Software)" title="Sphinx (Software)">Sphinx</a>, <a href="WEB_(Programmiersprache)" title="WEB (Programmiersprache)">CWEB</a>.</li></ul>

<div class="mw-heading mw-heading2"><h2 id="Weblinks">Weblinks</h2></div>

<div class="sisterproject" style="margin:0.1em 0 0 0;"><div class="noresize noviewer" style="display:inline-block; line-height:10px; min-width:1.6em; text-align:center;" aria-hidden="true" role="presentation"><span class="mw-default-size" typeof="mw:File"><span title="Commons"></span></span></div><b><span class=""><a class="external text" href="https://commons.wikimedia.org/wiki/Category:Doxygen?uselang=de"><span lang="en">Commons</span>: Doxygen</a></span></b> – Sammlung von Bildern, Videos und Audiodateien</div>

<div class="sisterproject" style="margin:0.1em 0 0 0;"><div class="noviewer" style="display:inline-block; line-height:10px; min-width:1.6em; text-align:center;" aria-hidden="true" role="presentation"><span class="mw-default-size" typeof="mw:File"><span title="Wikibooks"></span></span></div><b><a href="https://de.wikibooks.org/wiki/C%2B%2B-Programmierung:_Dokumentation_mit_Doxygen" class="extiw external" title="b:C++-Programmierung: Dokumentation mit Doxygen">Wikibooks: C++-Programmierung: Dokumentation mit Doxygen</a></b> – Lern- und Lehrmaterialien</div>

<ul><li><a rel="nofollow" class="external text" href="https://www.doxygen.nl/">doxygen.nl</a> (englisch)</li>

<li><a rel="nofollow" class="external text" href="https://sourceforge.net/projects/pas2dox/">Pas2Dox: Ein Pascal-Filter für Doxygen</a> (englisch)</li></ul>

<div class="mw-heading mw-heading2"><h2 id="Einzelnachweise">Einzelnachweise</h2></div>

<li id="cite_note-_d087fe8a254d28e6-1"><span class="mw-cite-backlink"><a href="#cite_ref-_d087fe8a254d28e6_1-0">↑</a></span> <span class="reference-text"><a rel="nofollow" class="external text" href="https://web.archive.org/web/20111004073015/http://lists.trolltech.com/qt-interest/1997-10/thread00297-0.html"><cite style="font-style:italic">web.archive.org</cite>.</a></span>

</li>

<li id="cite_note-_332f804fc8684018-2"><span class="mw-cite-backlink"><a href="#cite_ref-_332f804fc8684018_2-0">↑</a></span> <span class="reference-text"><a rel="nofollow" class="external text" href="https://github.com/doxygen/doxygen/releases/tag/Release_1_16_1"><cite style="font-style:italic"><span lang="en">Doxygen release 1.16.1</span></cite>.</a> 11. Januar 2026 (abgerufen am 12. Januar 2026).</span>

</li>

<li id="cite_note-_6c34e8a5d5e5402c-3"><span class="mw-cite-backlink"><a href="#cite_ref-_6c34e8a5d5e5402c_3-0">↑</a></span> <span class="reference-text"><a rel="nofollow" class="external text" href="https://sourceforge.net/projects/doxygen/"><cite style="font-style:italic">sourceforge.net</cite>.</a> In: <cite style="font-style:italic">SourceForge</cite>. (abgerufen am 29. September 2016).</span>

</li>

<li id="cite_note-4"><span class="mw-cite-backlink"><a href="#cite_ref-4">↑</a></span> <span class="reference-text"><span class="cite"><a rel="nofollow" class="external text" href="https://www.doxygen.nl/manual/markdown.html"><i>Doxygen Manual: Markdown support.</i></a><span class="Abrufdatum"> Abgerufen am 20. August 2020</span>.</span><span style="display: none;" class="Z3988" title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Adc&rfr_id=info%3Asid%2Fde.wikipedia.org%3ADoxygen&rft.title=Doxygen+Manual%3A+Markdown+support&rft.description=Doxygen+Manual%3A+Markdown+support&rft.identifier=https%3A%2F%2Fwww.doxygen.nl%2Fmanual%2Fmarkdown.html"> </span></span>

</li>

<li id="cite_note-5"><span class="mw-cite-backlink"><a href="#cite_ref-5">↑</a></span> <span class="reference-text"><span class="cite"><a rel="nofollow" class="external text" href="https://www.doxygen.nl/manual/changelog.html"><i>Doxygen Manual: Changelog.</i></a><span class="Abrufdatum"> Abgerufen am 20. August 2020</span>.</span><span style="display: none;" class="Z3988" title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Adc&rfr_id=info%3Asid%2Fde.wikipedia.org%3ADoxygen&rft.title=Doxygen+Manual%3A+Changelog&rft.description=Doxygen+Manual%3A+Changelog&rft.identifier=https%3A%2F%2Fwww.doxygen.nl%2Fmanual%2Fchangelog.html"> </span></span>

</li>

</ol></div><div><div class="zim-footer">

Dieser Artikel wurde von <a class="external text" title="Zuletzt bearbeitet am 2024-02-14" href="https://de.wikipedia.org/wiki/?title=Doxygen&oldid=242189712">Wikipedia</a> herausgegeben. Der Text ist unter <a class="external text" href="https://creativecommons.org/licenses/by-sa/4.0/deed.de">Creative Commons Attribution-Share Alike 4.0</a> verfügbar, sofern nicht anders angegeben. Für die Mediendateien können zusätzliche Bedingungen gelten.

</div>

</div></div>

</div>

</main>

</div>

</body></html>